chore: use cloud validations for packages/server api request/response types #32632
Conversation
cypress
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
chore/use-api-typedefs
|
| Run status |
|
| Run duration | 43m 47s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
1
|
Flaky
|
15
|
Pending
|
1102
|
Skipped
|
4
|
Passing
|
26706
|
| View all changes introduced in this branch ↗︎ | |
Warning
Partial Report: The results for the Application Quality reports may be incomplete.
UI Coverage
45.27%
|
|
|---|---|
|
Untested elements
|
186
|
|
Tested elements
|
158
|
Accessibility
97.99%
|
|
|---|---|
|
Failed rules
|
4 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
100
|
Tests for review
cypress/e2e/studio/studio.cy.ts • 1 failed test • app-e2e
| Test | Artifacts | |
|---|---|---|
| Cypress Studio > updates an existing test with assertions |
Test Replay
Screenshots
|
|
e2e/origin/config_env.cy.ts • 1 flaky test • 5x-driver-electron
| Test | Artifacts | |
|---|---|---|
| cy.origin- Cypress.config() > serializable > overwrites different values in secondary if one exists in the primary |
Test Replay
|
|
issues/28527.cy.ts • 1 flaky test • 5x-driver-electron
| Test | Artifacts | |
|---|---|---|
| issue 28527 > fails and then retries and verifies about:blank is not displayed |
Test Replay
Screenshots
|
|
commands/window.cy.js • 1 flaky test • 5x-driver-firefox
| Test | Artifacts | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ... > only logs once |
| |||||||||||||
| Test | Artifacts | |||||||
|---|---|---|---|---|---|---|---|---|
| src/cy/commands/files > #readFile > retries to read when ENOENT |
| |||||||
| Test | Artifacts | |
|---|---|---|
| issue 28527 > fails and then retries and verifies about:blank is not displayed |
Screenshots
|
|
The first 5 flaky specs are shown, see all 13 specs in Cypress Cloud.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| return cb(response) | ||
| } catch (err: unknown) { | ||
| onError(err) | ||
| debug('postInstanceTests failed, allowing browser to hang until it is killed: Error %o', { err }) |
There was a problem hiding this comment.
Bug: Error Handling Fails to Return Early After API Failure
The refactored error handling for _postInstanceTests in onTestsReceived is missing an explicit return statement in its catch block. This causes the function to continue executing after an API failure instead of returning early, which alters the intended behavior of letting the browser hang.
| .catch((err: any) => { | ||
| onError(err) | ||
|
|
||
| return responseDidFail |
There was a problem hiding this comment.
do we no longer need this logic?
| "dev": "node index.js", | ||
| "docker": "cd ../.. && WORKING_DIR=/packages/server ./scripts/run-docker-local.sh", | ||
| "postinstall": "patch-package", | ||
| "postinstall": "patch-package && yarn sync-cloud-validations", |
There was a problem hiding this comment.
if we are doing this at the package level, do we still need to call it in CI after the build? Would be nice to get rid of this https://github.com/cypress-io/cypress/blob/develop/.circleci/src/pipeline/@pipeline.yml#L201
Additional details
System tests currently fetch typescript definitions and example payloads for API endpoints when they run. This ensures our api calls are supported properly by the server.
This adds the same functionality to packages/server, so we can make sure our api functions use up-to-date typedefs from Cypress Cloud
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?Note
Adopts Cloud-provided validation types for server API requests/responses, adds a sync script and build hooks, and refactors record flow error handling with stricter typings.
lib/cloud/api/index.tsandlib/cloud/api/create_instance.ts(e.g.,PostRun*,PostRunInstance*,PostInstanceResults*).ping,getAuthUrls,createInstance,postInstanceTests,updateInstanceStdout,updateInstanceArtifacts,postInstanceResults, etc.).options.testingTypeand add localPutInstanceArtifactsResponseTypealias._postInstanceTestsinlib/modes/record.tsto async/await with try/catch usingcloudCannotProceedErr.onTestsReceivedto handle failures via try/catch and skip logic; emitproject.emit('end', { skippedSpec: true })on skip.scripts/sync-cloud-validations.shand npm scriptssync-cloud-validations,ensure-cloud-validations; run duringpostinstalland before TypeScript (build-prod,check-ts).zodand ignore generatedlib/validationsin.gitignore.Written by Cursor Bugbot for commit d7e2dd8. This will update automatically on new commits. Configure here.